Skip to main content
Version: 9.2

Deployment Definitions

A Deployment Definition is a set of instructions for a deployment job. It defines the package version to use, content from the package to include, and any content to be modified during deployment. You can configure the deployment definition to create a new application or to update an existing application.

Before You Begin​

Verify that the desired package and version have been created.

Create a Deployment Definition That Creates a New Application​

  1. In the Qrvey Admin Center, select the Content Deployment icon in the left navigation panel to display the Deployment Definitions tab.

  2. Select Create Definition to open the Deployment Definition Description page.

  3. At the top of the page, enter a name and description in the fields provided.

  4. From the Package to Deploy dropdown, select the package to use in this deployment.

  5. Select the Package Version dropdown and select the package version to deploy.

  6. Select the content to deploy:

    • Select Select Content. The Select Content dialog displays.

    • Select individual items to include in the deployment. To include all the content in the application, select Baseline (all content).

    • Select OK. The page updates to display the dependencies of each of your selections.

    Note: If you select content that has dependencies, the system automatically includes them in the deployment. For example, if you select a dashboard, but you do not select the datasets that power the charts on that dashboard, the system automatically includes that dataset.

  7. (Optional) To use APIs for Content Deployment, select Show Content ID. You need this information to call the API.

  8. Leave Create New Application (default) selected.

  9. Enter a name in the New Application Name field.

  10. (Optional) Enter a description in the Application Description field.

  11. Expand each selection to display its properties. Modify the properties as needed.

    For datasets, the default setting is to load the data when creating the dataset.

  12. Insert parameter tokens as needed.

    The deployment definition does not specify the target application. The deployment job contains that information. This separation enables you to define parameter tokens within a deployment definition to update multiple target applications for any number of users.

Parameter Tokens​

The deployment definition does not specify the target application. That information is defined in the deployment job. As an administrator, this separation enables you to use one deployment definition to update multiple target applications for any number of users. To take advantage of this capability when creating the deployment job, you must use parameter tokens, user-defined parameters that can replace any value and be configured for each recipient. The parameter token uses the following syntax:

{{tokenName}}

For example:

  • You can copy the same application to multiple instances, but with different options specified for each instance.
  • You can use different connection strings in each destination application, depending on the recipient user or tenant.

You can replace any value with a parameter token by typing your own token name inside two curly brackets ({}). When you enter the first bracket, the system provides contextual suggestions for naming the token. For example, if the source application connects to a database that is used for development and testing, and each copied destination application must be connected to a separate production database, you can replace the host URL of the source application with a parameter token such as {{hostURL}}. You can also accept a suggested token name such as {{connection.host_url}}. You can repeat this process to set the username and password of the connection to a token.

Parameter Token Use Case​

You might need to deploy an application that was created in a staging environment into several tenant accounts in a production environment. The source application is connected to a sample database that is used for development purposes, but each destination environment contains its own database. To achieve this goal, replace the following attributes of the database connection with parameter tokens:

  • Host URL: {{host-url}}
  • User Name: {{db-username}}
  • Password: {{prodPassword}}

When this deployment definition is used in a deployment job, the deployment job resolves the appropriate values for each token and creates the database connections.

Create a Deployment Definition That Updates an Existing Application​

  1. In the Qrvey Admin Center, select the Content Deployment icon in the left navigation panel to display the Deployment Definitions tab.

  2. Select Create Definition to display a form for adding definition information.

  3. In the fields provided, enter a name and description to replace the placeholder text.

  4. From the Package to Deploy dropdown, select the package to use in this deployment.

  5. Select the Version of the Package to Deploy dropdown, select a package version.

  6. Select the content to deploy:

    a. Select Select Content. The Select Content dialog displays.

    b. Select individual items to include in the deployment. To include all the content in the application, select Baseline (all content).

    c. Select OK. The page updates to reflect the dependencies of each of your selections.

  7. (Optional) To use APIs for Content Deployment, select Show Content ID. You need this information to call the API.

  8. Select Update an Existing Application.

  9. From the Select Fields to Update dropdown, select one of the following options and enter additional information as new fields are displayed:

    • Select All
    • Application Name
    • Application Description

  10. Expand the selections to display their properties. Modify the selections as needed.

    For datasets, the default setting is to load the data when creating the dataset.

Note: An unknown label might indicate a new connection type that has not yet been updated in the Content Deployment section. The new connection type can still be deployed, set up, and used.

Delete a Deployment Definition​

To delete an existing deployment definition, select its corresponding options menu from the definition table, then select Delete.

Note: You cannot delete a deployment definition if it is associated with a deployment job.

Update Custom Attributes​

By default, the Update Custom Attributes option is enabled in dashboards when selecting content.

Custom Attributes Enabled

When a customAttributes object contains IDs such as datasetId, chartId, dashboardId, and workflowId, they are replaced in the deployed application with new IDs.

To keep the IDs from updating in the target application’s customAttributes object, disable this option. After the application is deployed, the IDs in the customAttributes object remain the same as in the source application.

Note: Only IDs recognized by the Content Deployment process are affected by this functionality. Any other values added to the customAttributes object remain unchanged.